How Users Can Rate Search Results

About Ratings

The Ratings feature enables users to rate items such as documents, graphics, videos, etc., and see the average ratings for that item.

Ratings can be shown in the SmartHub site pages such as:

• Landing (landing.html) page
• Results (Results.html) page

Customizing Ratings

• To customize these files, open and modify the provided versions for customization located in the SmartHub directory below on the Windows server that hosts your SmartHub site:
  • C:\Program Files\BA Insight\SmartHub-version\CustomerCustomization\pages\
    • IndexCopy.html
    • ResultsCopy.html
  • Modify these files directly or, as BA Insight recommends, copy the entire CustomerCustomization directory and rename it as desired before you modify the files within it.
    
    • For more information, see How to Customize Your SmartHub User Interface.

Two templates are available:

• Stars/grades
  
• Likes

Stars

• Users can rate documents with a number of stars.
  • The value is then registered by SmartHub Analytics.
  • Score averages are computed.
  • When the user runs a query, the Results page that appears displays the average rating of the items returned (if the items have been rated).
• Grades go from 1 to a maximum grade value which is specified in the settings file (see below).
• The Stars template also contains a detailed view with the count for each grade.

Likes

The "like" templates enables users to like or dislike documents.

The document later displays likes and dislike statistics.

• A "like" is equivalent to the maximum defined grade from the settings file.
• A "dislike" is equivalent to a value of "1".

Like/Dislike Ratings Example

An example rating of documents, complete with Likes/Dislikes, is shown below:

Stars Ratings Example

An example rating of documents, complete with Stars, is shown below:

Restrictions

The items users rate must come from a writable backend The search engine your SmartHub instance uses to perform queries. SmartHub can be configured to use more than one search engine..

Currently, the only writable backends are Elastic and Azure.

Note: When using Ratings with an "Azure" backend make sure that the backend is writable

How to Configure Ratings

The configuration file must be used only as an example and should not be modified because it is overwritten at upgrade time.

The configuration settings can be found in the JavaScript file DefaultModuleSettings.js found in the SmartHub installation directory \modules\SmartHubResourceLoader\.

For information about how to create and use your own custom settings file (default files are overwritten by any product upgrade), see How to Customize Your SmartHub User Interface.

Note: The "escbasecrawlurl" and "ContentSource" metadata are required for this feature to work.
When using Ratings make sure that ContentSource is the index name and is all lowercase.

Ratings Code Example

Settings Example 

 "IndexSearchInterfaceElement":".CoveoContentBySearch",
 "ResultsSearchInterfaceElement":"#search.CoveoSearchInterface",
 "Enabled":"false",
 "EnabledInTabularView":"false",
 "EnabledInResultFeedback":"false",
 "ListTemplateParent":".list-info-wrapper .list-info:last-child",
 "CardTemplateParent":".card-front",
 "ExpanderTemplate":"/modules/Ratings/Templates/Expander.html",
 "TabularViewColumnName":"Ratings",
 "GradingTemplate":"/modules/Ratings/Templates/Ratings-Stars.html",
 "LikesTemplate":"/modules/Ratings/Templates/Ratings-Like.html",
 "ActiveTemplate":"GradingTemplate",
 "MaximumGrade":5,
 "VoteNotification": "Your vote has been registered and it will be processed soon.".toLocaleString(),
 "EscbasecrawurlMetadata": "escbasecrawlurl",
 "ContentSourceMetadata": "ContentSource"

Ratings Parameters

Ratings Example: Embedding Ratings in Your Index Page

The SmartHub Index page file is Index.html, which is located on the server that hosts your SmartHub site at <SmartHub_Install_Dir>\BA Insight\SmartHub-version-xxxx\

Index.html is the default index file; the file is overwritten at upgrade time.

To use a custom Index file, BA Insight recommends using the IndexCopy.html in the <SmartHub_Install_Dir>\BA Insight\SmartHub-version-xxxx\CustomerCustomization/pages directory. For more information about using custom files see How to Customize Your SmartHub User Interface.

Use the following steps to embed Ratings into your Index page:

1. Make a copy of the directory <SmartHub_Install_Dir>\BA Insight\SmartHub-version-xxxx\CustomerCustomization/.
2. Rename the new copy of the directory as you see fit.
3. Open the new directory, and then the pages folder.
4. Rename the file IndexCopy.html, if desired. Ex. CustomIndex.html, CustomLandingPage.html, IndexCustom.html, etc.
5. Open your custom Index page HTML file for editing.
   1. For more information, see How to Customize Your SmartHub User Interface.
6. Insert the Ratings code from "Ratings Code Example" above inside the Body tags, as desired.

7. Configure the following Ratings parameters:

   1. Enabled: true

   2. IndexSearchInterfaceElement: The class or the ID of the search interface to be used to render the results which show the ratings.

   3. A ResultList or a TabularView must be used in order to show the Ratings feature on the page.

      1. Example: By default, Index.html contains multiple ContentBySearch elements.

         1. To enable ratings only on the “Interests” element, the Ratings code would be inserted and the parameter IndexSearchInterfaceElement would be set to “#InterestsCBS”

         2. The element - InterestsCBS in this case - can be whatever ID or class the element has. It is an identifier for the HTML element you are targeting.

8. Use the "Ratings Parameters" table above to further configure your Ratings feature.
9. Save your custom Index HTML file.
10. Set IIS to load your new custom Index page file instead of the default Index page. See "How to Load Your Custom Index Page in IIS" in How to Customize Your SmartHub User Interface.

Sorting

Sorting can be done based on rating.

In the example below, the data sort criteria WilsonsScore is used.

To enable sorting based on rating, the sort section from the page's HTML is updated with the following line:

 <span class="CoveoSort" data-sort-criteria="@WilsonsScore descending,@WilsonsScore ascending"   data-caption="Rating"></span>

Example

<div class="coveo-sort-section">    
    <span class="CoveoSort" data-sort-criteria="relevancy" data-caption="Relevance"></span>
    <span class="CoveoSort" data-sort-criteria="date descending,date ascending" data-caption="Date"></span>    
    <span class="CoveoSort" data-sort-criteria="@WilsonsScore descending,@WilsonsScore ascending"  data-caption="Rating"></span> 
</div>

Facets

To filter the results based on the ratings the following metadata is available: AvgGrade

The facet can be added to the page as a Range Facet or as a Slider Facet.

In order to use the ratings refiner as a Range Facet the Range Facets Pipeline must be configured.

Example

<RangeFacetsConfig> 
  <Facet name="AvgGrade" isDateInterval = "false">    
    <Intervals minLabel="No Stars" maxLabel = "5 Stars"> 
      <Interval startPoint="1" endPoint="1.99">1 Star</Interval>      
      <Interval startPoint="1.99" endPoint="2.99">2 Stars</Interval>      
      <Interval startPoint="2.99" endPoint="3.99">3 Stars</Interval>      
      <Interval startPoint="3.99" endPoint="4.99">4 Stars</Interval>    
    </Intervals>  
  </Facet> 
</RangeFacetsConfig>

The facets section from the page's HTML must be updated with the following line:

<div class="CoveoFacet" data-default-state="expanded" data-title="AvgGrade" data-field="@AvgGrade" data-lookup-field="@AvgGrade" data-available-sorts="alphadescending" data-use-and="true"></div>

In order to use the ratings refiner as a Slider the facets section from the page's HTML must be updated with the following line:

<div class="CoveoFacetSlider" data-default-state="expanded" data-title="AvgGrade" data-field="@AvgGrade" data-lookup-field="@AvgGrade" data-steps="5" data-range-slider="true" data-date-field="false" data-start="0" data-end="5"></div>

If an Elastic backend is used, make sure that AvgGrade is declared as a NumericProperties in the Elastic Translator Stage.